home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / clipper / nfsrc21.zip / MENUTO.PRG < prev    next >
Text File  |  1992-10-16  |  20KB  |  595 lines
  1. /*
  2.  * File......: MENUTO.PRG
  3.  * Author....: Ted Means
  4.  * Date......: $Date:   16 Oct 1992 00:20:28  $
  5.  * Revision..: $Revision:   1.5  $
  6.  * Log file..: $Logfile:   C:/nanfor/src/menuto.prv  $
  7.  * 
  8.  * This is an original work by Ted Means and is placed in the
  9.  * public domain.
  10.  *
  11.  * Modification history:
  12.  * ---------------------
  13.  *
  14.  * $Log:   C:/nanfor/src/menuto.prv  $
  15.  * 
  16.  *    Rev 1.5   16 Oct 1992 00:20:28   GLENN
  17.  * Cleaned up documentation header.
  18.  * 
  19.  *    Rev 1.4   16 Oct 1992 00:08:44   GLENN
  20.  * Just making sure we had Ted's latest revision.
  21.  * 
  22.  *    Rev 1.3   13 Oct 1992 20:45:46   GLENN
  23.  * Complete rewrite by Ted Means, dumping assembler version for a
  24.  * Clipper version.
  25.  * 
  26.  *    Rev 1.2   15 Aug 1991 23:03:54   GLENN
  27.  * Forest Belt proofread/edited/cleaned up doc
  28.  * 
  29.  *    Rev 1.1   14 Jun 1991 19:52:16   GLENN
  30.  * Minor edit to file header
  31.  * 
  32.  *    Rev 1.0   01 Apr 1991 01:01:42   GLENN
  33.  * Nanforum Toolkit
  34.  *
  35.  */
  36.  
  37. /*  $DOC$
  38.  *  $FUNCNAME$
  39.  *     FT_Prompt()
  40.  *  $CATEGORY$
  41.  *     Menus/Prompts
  42.  *  $ONELINER$
  43.  *     Define a menu item for use with FT_MenuTo()
  44.  *  $SYNTAX$
  45.  *     #include "FTMENUTO.CH"
  46.  *
  47.  *     @ <nRow>, <nCol> PROMPT <cPrompt>                     ;
  48.  *                      [COLOR <cColor>]                     ;
  49.  *                      [MESSAGE <cMessage>]                 ;
  50.  *                      [MSGROW <nMsgRow>]                   ;
  51.  *                      [MSGCOL <nMsgCol>]                   ;
  52.  *                      [MSGCOLOR <cMsgColor>]               ;
  53.  *                      [TRIGGER <nTrigger>]                 ;
  54.  *                      [TRIGGERCOLOR <cTriggerColor>]       ;
  55.  *                      [HOME <nHome>]                       ;
  56.  *                      [END <nEnd>]                         ;
  57.  *                      [UP <nUp>]                           ;
  58.  *                      [DOWN <nDown>]                       ;
  59.  *                      [LEFT <nLeft>]                       ;
  60.  *                      [RIGHT <nRight>]                     ;
  61.  *                      [EXECUTE <bExec>]                    ;
  62.  *
  63.  *  $ARGUMENTS$
  64.  *     <nRow> is the row at which the prompt is to appear.
  65.  *
  66.  *     <nCol> is the column at which the prompt will appear.
  67.  *
  68.  *     <cPrompt> is the menu item string.
  69.  *
  70.  *     <cColor> is optional and is the color attribute of the prompt.  Note
  71.  *     that two colors are required; one for the standard setting and one
  72.  *     for the enhanced setting (i.e. the light bar color).  See the example
  73.  *     below if this isn't clear.  If <cColor> is not specified then the
  74.  *     current SetColor() value is used by default.
  75.  *
  76.  *     <cMessage> is optional and is the message associated with the
  77.  *     prompt. If not specified, then no message will be displayed.
  78.  *
  79.  *     <nMsgRow> is optional and is the row at which the message, if any,
  80.  *     will appear.  If not specified, the default is the current setting
  81.  *     of the SET MESSAGE TO command.
  82.  *
  83.  *     <nMsgCol> is optional and is the column at which the message, if
  84.  *     any, will appear.  If not specified, the default is either zero or
  85.  *     centered, depending on the current setting of the CENTER option of
  86.  *     the SET MESSAGE TO command.
  87.  *
  88.  *     <cMsgColor> is optional and is the color attribute of the message.
  89.  *     If not specified, the default is the same as the prompt color.
  90.  *
  91.  *     <nTrigger> is optional and is the position within the prompt string
  92.  *     where the trigger character is located.  If not specified, the
  93.  *     default is one.
  94.  *
  95.  *     <cTriggerColor> is optional and is the color attribute of the trigger
  96.  *     character.  Note that two colors are required; one for the standard
  97.  *     setting and one for the enhanced setting (i.e. the light bar color).
  98.  *     See the example below if this isn't clear.  If <cTriggerColor> is not
  99.  *     specified then the default is the same color as the rest of the
  100.  *     prompt.
  101.  *
  102.  *     <nHome> is optional and specifies which prompt becomes active
  103.  *     when the home key is pressed.  If not specified, the default is
  104.  *     the first prompt.
  105.  *
  106.  *     <nEnd> is optional and specifies which prompt becomes active
  107.  *     when the end key is pressed.  If not specified, the default is
  108.  *     the last prompt.
  109.  *
  110.  *     <nUp> is optional and specifies which prompt becomes active
  111.  *     when the up arrow key is pressed.  If not specified, the
  112.  *     default is the previous prompt.  The current setting of SET
  113.  *     WRAP TO is obeyed.
  114.  *
  115.  *     <nDown> is optional and specifies which prompt becomes
  116.  *     active when the down arrow key is pressed.  If not
  117.  *     specified, the default is the next prompt.  The current
  118.  *     setting of SET WRAP TO is obeyed.
  119.  *
  120.  *     <nRight> is optional and specifies which prompt becomes
  121.  *     active when the right arrow key is pressed.  If not
  122.  *     specified, the default is the next prompt.  The current
  123.  *     setting of SET WRAP TO is obeyed.
  124.  *
  125.  *     <nLeft> is optional and specifies which prompt becomes
  126.  *     active when the left arrow is pressed.  If not specified,
  127.  *     the default is the previous prompt.  The current setting of
  128.  *     SET WRAP TO is obeyed.
  129.  *
  130.  *     <bExec> is optional and is a code block to evaluate whenever
  131.  *     the menu item to which it belongs is selected.
  132.  *  $DESCRIPTION$
  133.  *     Clipper's @...PROMPT and MENU TO commands are fine as far as
  134.  *     they go.  But many times you need more flexibility.  As
  135.  *     you'll no doubt notice if you read the argument list, this
  136.  *     function is almost completely flexible. You can adjust
  137.  *     locations and colors for every part of the prompt and its
  138.  *     associated message.  In addition, since you can control the
  139.  *     effect of the arrow keys, you can allow both horizontal and
  140.  *     vertical movement, or even disable certain arrow keys if you
  141.  *     so desire.  Support for nested menus is also available, since
  142.  *     the prompts are stored in stack-based static arrays.
  143.  *
  144.  *     Note that this command can also be called using function-style
  145.  *     syntax.  See the entry for FT_PROMPT() for further details.
  146.  *
  147.  *     This enhanced version of @...PROMPT requires the inclusion of
  148.  *     the header file FTMENUTO.CH in any source file that uses it.
  149.  *     It is may be used in place of the standard Clipper @...PROMPT
  150.  *     command.  However, in the interests of functionality it is NOT
  151.  *     100% compatible.  No whining!  If compatibility is such a big
  152.  *     deal then use the standard Clipper commands.
  153.  *
  154.  *  $EXAMPLES$
  155.  *    #include "FTMENUTO.CH"
  156.  *
  157.  *    // Simple prompt
  158.  *    @ 1, 1 PROMPT "Menu choice #1"
  159.  *
  160.  *    // Prompt with color
  161.  *    @ 3, 1 PROMPT "Menu choice #2" COLOR "W+/R,W+/B"
  162.  *
  163.  *    // Prompt with a message
  164.  *    @ 5, 1 PROMPT "Menu choice #3" MESSAGE "Go to lunch"
  165.  *
  166.  *    // Prompt with pinpoint message control
  167.  *    @ 7, 1 PROMPT "Menu choice #4" MESSAGE "Drop Dead" ;
  168.  *                   MSGROW 22 MSGCOL 4 MSGCOLOR "GR+/N"
  169.  *
  170.  *    // Prompt with a trigger character ("#" character)
  171.  *    @11, 1 PROMPT "Menu choice #6" TRIGGER 13
  172.  *
  173.  *    // Prompt with trigger character color control
  174.  *    @13, 1 PROMPT "Menu Choice #7" TRIGGER 13 TRIGGERCOLOR "R+/BG,G+/N"
  175.  *
  176.  *    // Prompt with right and left arrow keys disabled
  177.  *    @15, 1 PROMPT "Menu Choice #8" RIGHT 8 LEFT 8
  178.  *  $INCLUDE$
  179.  *     FTMENUTO.CH
  180.  *  $SEEALSO$
  181.  *   
  182.  *  $END$
  183.  */
  184.  
  185. #include "SETCURS.CH"
  186. #include "INKEY.CH"
  187.  
  188. #xcommand if <true> then <action> => ;
  189.           if <true> ; <action> ; end
  190.  
  191. #xtranslate display( <row>, <col>, <stuff>, <color> ) => ;
  192.             setpos( <row>, <col> ) ; dispout( <stuff>, <color> )
  193.  
  194. #xtranslate EnhColor( <colorspec> ) => ;
  195.             substr( <colorspec>, at( ",", <colorspec> ) + 1 )
  196.  
  197. #xtranslate isOkay( <exp> ) => ;
  198.             ( <exp> \> 0 .and. <exp> \<= nCount )
  199.  
  200. #xtranslate isBetween( <val>, <lower>, <upper> ) => ;
  201.             ( <val> \>= <lower> .and. <val> \<= <upper> )
  202.  
  203. #define nTriggerInkey asc( upper( substr( cPrompt, nTrigger, 1 ) ) )
  204. #def